home *** CD-ROM | disk | FTP | other *** search
- HELPBAT.DOC June 1992 Ronny Richardson
- ----------------------------------------------------------------
- Purpose: HELPBAT2.BAT, CHK2.BAT, and HELPBAT.BAT are three
- batch files designed to add a simple help system to
- your existing batch files.
-
- Comments: By adding a few lines to your existing batch files,
- you can create a simple help system that makes it
- easy to find the right file for the job.
-
- Usage: HELPBAT.BAT gives you a list of each batch file and
- its purpose (those that have been edited like
- HELPBAT2.BAT in the example).
-
- Start every batch file you use with these three lines
- of information:
-
- @ECHO OFF <use ECHO OFF for DOS prior to 3.3>
- REM NAME: CHECK.BAT <substitute your filename>
- REM PURPOSE: Run CHKDSK <substitute purpose>
-
- Use capital letters for NAME and PURPOSE to ensure that
- DOS case-sensitive searches will find the lines. It
- doesn't hurt to add VERSION and DATE lines like these
- to provide an audit trail for tracking modifications:
-
- REM VERSION: 1.00 <substitute version number>
- REM DATE: May 20, 1991 <substitute date here>
-
- After you have modified your files, HELPBAT.BAT
- rummages through each batch file on your disk and
- displays its name and purpose. In this example, it
- is assumed that you keep all your batch files in a
- common directory such as C:\BATCH.
-
-
-